ci: add workflow to regenerate models from OpenAPI spec by vdusek · Pull Request #694 · apify/apify-client-python

vdusek · 2026-03-31T10:33:59Z

Summary

Add workflow_dispatch workflow that regenerates Pydantic models from an apify-docs PR's OpenAPI spec
Builds the spec locally, runs datamodel-codegen, and opens a PR if models changed
Comments back on the source apify-docs PR with a link

Issues

Closes: Automate PR creation when OpenAPI spec is updated #618

Context

codecov · 2026-03-31T10:36:59Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.68%. Comparing base (b778c20) to head (bdfe4bf).
⚠️ Report is 26 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #694      +/-   ##
==========================================
- Coverage   94.80%   94.68%   -0.12%     
==========================================
  Files          45       45              
  Lines        4404     4403       -1     
==========================================
- Hits         4175     4169       -6     
- Misses        229      234       +5

Flag	Coverage Δ
integration	`94.68% <ø> (-0.12%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Copilot

Pull request overview

Adds a manually triggered GitHub Actions workflow to regenerate this repo’s generated Pydantic models from an OpenAPI spec produced in an apify/apify-docs PR, and open/update a PR with the updated src/apify_client/_models.py.

Changes:

Introduces a workflow_dispatch workflow that checks out apify/apify-docs at a provided commit SHA and builds the bundled OpenAPI JSON.
Runs model generation via datamodel-codegen, detects changes, and creates/updates a PR in this repo.
Posts a cross-repo comment back to the originating apify-docs PR with the created/updated PR link (and a failure comment on error).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.github/workflows/regenerate_models.yaml

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.github/workflows/regenerate_models.yaml

janbuchar · 2026-04-03T18:11:28Z

.github/workflows/regenerate_models.yaml

This should follow the conventions (manual_regenerate_models.yaml)

janbuchar · 2026-04-03T18:14:43Z

.github/workflows/regenerate_models.yaml

+      - name: Configure git
+        if: steps.changes.outputs.changed == 'true'
+        run: |
+          git config user.name "apify-service-account"
+          git config user.email "apify-service-account@users.noreply.github.com"
+
+      - name: Create or update PR
+        if: steps.changes.outputs.changed == 'true'
+        id: pr
+        env:
+          GH_TOKEN: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
+        run: |
+          BRANCH="update-models-docs-pr-${DOCS_PR_NUMBER}"
+          DOCS_PR_URL="https://github.com/apify/apify-docs/pull/${DOCS_PR_NUMBER}"
+          TITLE="[TODO]: update generated models from apify-docs PR #${DOCS_PR_NUMBER}"
+
+          # -B creates the branch or resets it if it already exists (re-runs for the same docs PR).
+          git checkout -B "$BRANCH"
+          git add src/apify_client/_models.py
+          git commit -m "$TITLE"
+          git push --force origin "$BRANCH"
+
+          EXISTING_PR=$(gh pr list --head "$BRANCH" --json url --jq '.[0].url' 2>/dev/null || true)
+
+          if [[ -n "$EXISTING_PR" ]]; then
+            echo "PR already exists: $EXISTING_PR"
+            echo "pr_url=$EXISTING_PR" >> "$GITHUB_OUTPUT"
+            echo "created=false" >> "$GITHUB_OUTPUT"
+          else
+            BODY=$(cat <<EOF
+          This PR updates the auto-generated Pydantic models based on OpenAPI specification changes in [apify-docs PR #${DOCS_PR_NUMBER}](${DOCS_PR_URL}).
+
+          ## Changes
+
+          - Regenerated \`src/apify_client/_models.py\` using \`datamodel-codegen\`
+
+          ## Source
+
+          - apify-docs PR: ${DOCS_PR_URL}
+          EOF
+            )
+
+            PR_URL=$(gh pr create \
+              --title "$TITLE" \
+              --body "$BODY" \
+              --head "$BRANCH" \
+              --base master)
+            echo "Created PR: $PR_URL"


These steps should use the commonly used reusable actions (add-and-commit and so on)

janbuchar

Consider my comments non-blocking, merge as you see fit.

vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Mar 31, 2026

vdusek self-assigned this Mar 31, 2026

github-actions bot added this to the 137th sprint - Tooling team milestone Mar 31, 2026

vdusek mentioned this pull request Mar 31, 2026

ci: add workflow to regenerate models from OpenAPI spec changes #657

Closed

4 tasks

ci: add workflow to regenerate models from OpenAPI spec changes

3c43378

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

vdusek force-pushed the ci/regenerate-models-workflow branch from a91f4ee to 3c43378 Compare April 1, 2026 14:23

vdusek mentioned this pull request Apr 1, 2026

ci: trigger Python client model regeneration on OpenAPI spec changes apify/apify-docs#2381

Open

vdusek requested review from Pijukatel and janbuchar April 1, 2026 14:26

fix: rename branch, clean up quotes, use placeholder PR title

e5c2d39

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Pijukatel requested a review from Copilot April 2, 2026 07:10

Copilot started reviewing on behalf of Pijukatel April 2, 2026 07:11 View session

Copilot AI reviewed Apr 2, 2026

View reviewed changes

vdusek added 2 commits April 2, 2026 14:02

Address feedback

706eb4d

use artifacts

30d9596

vdusek requested a review from Copilot April 2, 2026 12:14

Copilot started reviewing on behalf of vdusek April 2, 2026 12:14 View session

Copilot AI reviewed Apr 2, 2026

View reviewed changes

.github/workflows/regenerate_models.yaml Outdated Show resolved Hide resolved

.github/workflows/regenerate_models.yaml Show resolved Hide resolved

.github/workflows/regenerate_models.yaml Show resolved Hide resolved

address feedback

bdfe4bf

Pijukatel approved these changes Apr 2, 2026

View reviewed changes

janbuchar reviewed Apr 3, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: add workflow to regenerate models from OpenAPI spec#694

ci: add workflow to regenerate models from OpenAPI spec#694
vdusek wants to merge 5 commits intomasterfrom
ci/regenerate-models-workflow

vdusek commented Mar 31, 2026 •

edited

Loading

Uh oh!

codecov bot commented Mar 31, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

janbuchar Apr 3, 2026 •

edited

Loading

Uh oh!

janbuchar Apr 3, 2026

Uh oh!

janbuchar left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

vdusek commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Issues

Context

Uh oh!

codecov bot commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

janbuchar Apr 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

janbuchar Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

janbuchar left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

vdusek commented Mar 31, 2026 •

edited

Loading

codecov bot commented Mar 31, 2026 •

edited

Loading

janbuchar Apr 3, 2026 •

edited

Loading